5.1 新增外部用户
Path: /api/v2/externalUser/create
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
- 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
- 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户与角色”(原“用户管理”)页面,查看响应体数据获取对应用户目录的ID
- 认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
- 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
- 角色ID获取方式,可通过openAPI的外部用户角色查询接口获取
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 必须 | 用户名 | ||
userDirectoryId | string | 与userDirectoryName二选一 | 所属用户目录ID | userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准 | |
userDirectoryName | string | 与userDirectoryId二选一 | 所属用户目录名称 | userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准 | |
path | string | 必须 | 所属组织架构 | ||
displayName | string | 非必须 | 显示名 | ||
externalId | string | 非必须 | 外部ID,不传默认由服务端生成 | ||
status | number | 非必须 | 1 | 启用状态,0禁用,1启用 | |
description | string | 非必须 | 描述 | ||
string | 非必须 | 邮箱 | |||
phone | string | 非必须 | 手机号码 | ||
expiredTime | string | 非必须 | "0" | 过期时间,时间戳,13位长度,单位毫秒,'0'表示永不过期 | |
ext | object | 非必须 | 拓展字段 | ||
├─fieldDataSource | object | 非必须 | 认证时用户数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段 | ||
├─├─displayName | string | 非必须 | local | 显示名数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段 | |
├─├─description | string | 非必须 | local | 描述数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段 | |
string | 非必须 | local | 电子邮件数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段 | ||
├─├─expiredTime | string | 非必须 | local | 过期时间数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段 | |
├─├─phone | string | 非必须 | local | 手机号码数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段 | |
├─├─status | string | 非必须 | local | 启用状态数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段 | |
authComposeId | string | 非必须 | 认证策略ID | authComposeId和authComposeName只传一个即可,都传时以authComposeId为准 >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <2.2.5:不支持传空字符串,不传为默认策略。 |
|
authComposeName | string | 非必须 | 认证策略名称 | authComposeId和authComposeName只传一个即可,都传时以authComposeId为准 >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <2.2.5:不支持传空字符串,不传为默认策略。 |
|
userPolicyId | string | 非必须 | 用户策略ID | userPolicyId和userPolicyName只传一个即可,都传时以userPolicyId为准 >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <2.2.5:不支持传空字符串,不传为默认策略。 |
|
userPolicyName | string | 非必须 | 用户策略名称 | userPolicyId和userPolicyName只传一个即可,都传时以userPolicyId为准 >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <2.2.5:不支持传空字符串,不传为默认策略。 |
|
roleIdList | string[] | 非必须 | 角色ID列表 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 | |
roleNameList | string[] | 非必须 | 角色名称列表 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 |
请求示例
{
"userDirectoryName": "LDAP用户目录",
"status": 1,
"name": "test",
"path": "/",
"description": "测试外部用户",
"email": "test@test.com",
"phone": "123456",
"roleIdList": ["41d98830-f35f-11eb-9fa6-51583517c5f3"],
"authComposeId": "d36ccb20-596a-11eb-a393-bbd9cb0893d1",
"expiredTime": "1611158399000",
"ext": {
"fieldDataSource": {
"status": "local",
"expiredTime": "local",
"description": "server",
"phone": "local",
"email": "local",
"path": "server",
}
},
"userPolicyId": "default"
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 错误码,非0表示错误,具体含义请参考错误码定义 | ||
data | object | 必须 | 返回内容 | ||
msg | string | 必须 | 描述信息 |
返回示例
{
"code": 0,
"data": {
"data": "80fe1510-f758-11eb-a07c-6b595cbcb7ce"
},
"msg": "请求成功",
"traceId": "03300e0295801000"
}
错误信息
错误提示 | 错误码 |
---|---|
请输入正确的所属组织架构格式:请以“/”开头,组织架构路径不能有连续“/”,且不能以“/”结尾 | 7201 |
userDirectoryId参数内容不允许为空,请补充参数后重试 | 7201 |
该输入项目必须是手机号码格式, 如:[国际区号-]手机号,由数字组成,长度为6-20位 | 7201 |
该输入项目必须是电子邮箱格式,如:xxx@xx.com | 7201 |
用户目录不存在 | 77200001 |
用户目录不存在 | 77200004 |
参数检查出错 | 10000001 |
用户最多关联2000个角色 | 10000000 |
所属组织架构路径层级不能超过32级 | 10000001 |
用户或用户组织架构最多关联1000个应用 | 77200007 |
用户名(%s)已存在 | 77200005 |
角色不存在 | 77200001 |
认证策略不存在 | 77200001 |
认证策略不存在 | 77200004 |
用户策略不存在 | 77200001 |
用户策略不存在 | 77200004 |
保存失败,关联的角色不存在 | 77200004 |
保存失败,关联的应用不存在或已被删除 | 77200004 |
保存失败,关联的应用分类不存在或已被删除 | 77200004 |
外部ID重复,请重新输入 | 77200004 |
操作失败 | 10000000 |